chore(deps): update dependency typedoc to ^0.28.0 #1174

renovate · 2022-08-17T00:08:37Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
typedoc (source)	`^0.17.8` -> `^0.28.0`

Release Notes

TypeStrong/TypeDoc (typedoc)

`v0.28.0`

Compare Source

Breaking Changes

TypeDoc now expects all input globs paths to be specified with / path separators, #2825.
TypeDoc's --entryPointStrategy merge mode now requires JSON from at least version 0.28.0.
Removed jp translations from lang, to migrate switch to ja.
File name references in intentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.
The source-order sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.
TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set
this change improves handling of monorepo setups where some packages have readme files and others do not, #2875.
Function-like variable exports will now only be automatically converted as function types if
they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
with the @function tag, #2881.
Object literal type alias types will now be converted in a way which causes them to be rendered more similarly
to how interfaces are rendered, #2817.

API Breaking Changes

ProjectReflection.getReflectionFromSymbol and ProjectReflection.getSymbolFromReflection have been moved to Context
Path and PathArray parameter types now always contain normalized paths.
Introduced a Router which is used for URL creation. Reflection.url,
Reflection.anchor, and Reflection.hasOwnDocument have been removed.
Deserializer.reviveProject(s) no longer accepts an option to add project documents.
Deserializer.reviveProjects now requires an alwaysCreateEntryPointModule option.
Comment.serializeDisplayParts no longer requires a serializer argument.
ReflectionSymbolId.fileName is now optional, TypeDoc now stores a combination of a package name and package relative path instead.
The fileName property will be present when initially created, but is not serialized.
Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.
i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.
ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings.
The methods on Internationalization to do this previously have been removed.
The HTML output structure for the search box has changed to support the new modal.
DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful
methods now require both a reflection and a type in order to support
@expandType

Features

Add support for TypeScript 5.8.x
The search modal in the HTML output has been rewritten to provide better mobile support
Added a --router option which can be used to modify TypeDoc's output folder
structure. This can be extended with plugins, #2111.
Introduced the @primaryExport modifier tag to provide more fine grained
control over export conversion order, #2856
Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.
TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #2528.
Type packageOptions as Partial<TypeDocOptions>, #2878.
TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.
Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.
Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #2872.
Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #2862.
Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #2862.
API: Introduced DefaultThemeRenderContext.reflectionIcon for more granular control over displayed reflection icons.

Bug Fixes

TypeDoc will now only create references for symbols re-exported from modules.
Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #2824.
User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
Fixed handling of expando functions which were also merged with a namespace, #2876.
Fixed rendering of function types within arrays and union types, #2892.
Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.

Thanks!

`v0.27.9`

Compare Source

This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.

Features

Added support for TypeScript 5.8

`v0.27.8`

Compare Source

Features

The visibilityFilter option now supports individual signatures, #2846.
The favicon option may now be given a link starting with https?:// instead of a path, #2851.
TypeDoc now supports specifying # as the link in externalSymbolLinkMappings to indicate the type should not be linked to, #2853.

Bug Fixes

Fixed an issue where unrecognized languages would incorrectly be listed in the list of languages with translations, #2852.
Unresolved external type references will no longer incorrectly linked to undefined, #2854.

Thanks!

`v0.27.7`

Compare Source

Features

@includeCode and @inline can now inject parts of files using region
names or line numbers, #2816.
Introduced ja translation options, deprecated jp in favor of ja, #2843.
Improved TypeDoc's --watch option to support watching files not caught by
TypeScript's watch mode, #2675.
The @inline tag now works in more places for generic types.
Visibility filters now consider individual signatures, #2846.

Bug Fixes

Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, #2823.
Improved narrator support for labeling icons, #2832.
Fixed an issue with @class incorrectly handling mapped types, #2842.
TypeDoc will now consider symbols to be external only if all of their declarations are external
so that declaration merged members with global symbols can be documented, #2844.
Fixed an issue where TypeDoc would constantly rebuild, #2844.
Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, #2845.

Thanks!

`v0.27.6`

Compare Source

Features

Added ignoredHighlightLanguages option to specify languages which will be
allowed in code blocks but not highlighted, #2819.

Bug Fixes

@include and @includeCode now work in the readme file, #2814.
TypeDoc will now avoid making references to references, #2811.
Fixed output specific option specification, #2818.
Improved type reference conversion to avoid including defaulted type arguments, #2820.
Fixed parsing of declaration references which include a module and a local reference, #2810.
Improved link resolution logic to prioritize type alias properties with the
same symbol over type literal properties within function parameters.

`v0.27.5`

Compare Source

Bug Fixes

Possibly Breaking: TypeDoc will no longer render anchors within the page for
deeply nested properties. This only affects links to properties of
properties of types, which did not have a clickable link exposed so are
unlikely to have been linked to. Furthermore, these links were not always
created by TypeDoc, only being created if all parent properties contained
comments, #2808.
TypeDoc will now warn if a property which does not have a URL within the
rendered document and the parent property/page will be linked to instead,
#2808. These warnings can be disabled with the validation.rewrittenLink
option.
Fix restoration of groups/categories including documents, #2801.
Fixed missed relative paths within markdown link references in documents.
Improved handling of incomplete inline code blocks within markdown.
Direct https:// links under the hostedBaseUrl option's URL will no
longer be treated as external, #2809.

Thanks!

@SacDeNoeuds

`v0.27.4`

Compare Source

Features

API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
@include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
Cascaded modifier tags will no longer be copied into type literals, #2802.
@summary now works to describe functions within modules, #2803.
Corrected navigation showing module link as current when not on module page, #2805.

`v0.27.3`

Compare Source

Features

Added support for PNG favicons, #2790.
Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

Add special handling for import types with type errors discarded with ts-expect-error, #2792.
Fixed low contrast in default colors for properties/accessors in light mode, #2795.
The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

`v0.27.2`

Compare Source

Bug Fixes

Fix crash with TypeScript 5.5.x, #2789.

`v0.27.1`

Compare Source

Bug Fixes

Include classes which inherit from another package in class hierarchy in packages mode, #2467.
Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
Fixed automatic discovery of entry points in packages mode.
Reverted accidental style change for hierarchy page introduced in 0.27.0
The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

`v0.27.0`

Compare Source

Breaking Changes

Convert to ESM to enable easier use of ESM-only dependencies.
Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
Relaxed requirements for file names and generated url fragments. This may
result in a different file name structure, #2714.
Anchors to document headings and reflections within a HTML generated pages
have changed. They can be partially restored to the previous format by
setting --sluggerConfiguration.lowercase false. This change was made to
more closely match the default behavior of GitHub's markdown rendering and
VSCode's autocomplete when creating a relative link to an external markdown
file.
Removed the hideParameterTypesInTitle option, this was originally added as
a workaround for many signatures overflowing the available horizontal space
in rendered pages. TypeDoc now has logic to wrap types/signatures smartly,
so this option is no longer necessary.
Changed the default kindSortOrder to put references last.
Changed the default sort order to use alphabetical-ignoring-documents
instead of alphabetical.
Changed default of suppressCommentWarningsInDeclarationFiles to true
API: Constructor signatures now use the parent class name as their name
(e.g. X, not new X)
API: @group, @category, @groupDescription and @categoryDescription
will no longer be removed from the reflections they are present on. They are
skipped during rendering with the notRenderedTags option.

Features

Add support for TypeScript 5.7
TypeDoc will now discover entry points from package.json exports if they
are not provided manually, #1937.
Relative links to markdown files may now include #anchor links to
reference a heading within them.
Improved support for @param comments with nested object types, #2555.
Improved support for @param comments which reference a type
alias/interface. Important properties on the referenced type can now be
highlighted with @param options.foo, which will result in the additional
note being included under the documentation for that parameter, #2147. Note:
This feature is limited to references. It is not supported on other types of
types.
Added a new outputs option which is an array of outputs. This can be used
to render the documentation multiple times with different rendering options
or output types, #2597.
Added support for rendering alerts (or callouts) in markdown.
Add support for an @expand tag which can be placed on type aliases and
interfaces. When a type with @expand is referenced and TypeDoc has a place
to include additional details about the type, the properties of the type
will be included in the page where @expand is found. Note that use of this
tag can significantly increase the size of your generated documentation if
it is applied to commonly used types as it will result in inlining the
comments for those types everywhere they are referenced, #2303.
Add support for an @inline tag which can be placed on type aliases and
interfaces. When a type with @inline is referenced, TypeDoc will resolve
the referenced type and convert the type as if it was included directly
within the referencing type. Note that use of this tag can significantly
increase the size of your generated documentation if it is applied to
commonly used types as it will result in inlining the comments for those
types everywhere they are referenced, #2303.
Introduced a new @useDeclaredType tag for type aliases which can sometimes
improve their documentation, #2654.
Added a new @mergeModuleWith tag which can be used to tell TypeDoc to
place a module/namespace's children under a different module/namespace and
remove the real parent, #2281.
Added new @include and @includeCode inline tags to include files within
comments/documents.
Add notRenderedTags option. This option is similar to the excludeTags
option, but while excludeTags will result in the tag being completely
removed from the documentation, notRenderedTags only prevents it from
being included when rendering.
Added groupReferencesByType option.
Added navigation.excludeReferences option
Added useFirstParagraphOfCommentAsSummary option to configure how TypeDoc
handles comments for module members without the @summary tag.
Introduced favicon option to specify a .ico or .svg favicon to reference.
Sections within the page and in the "On This Page" navigation are now tied
together and will expand/collapse together, #2335.
API: Introduced a new app.outputs object for defining new output strategies.
API: TypeDoc's CSS is now wrapped in @layer typedoc, #2782.

Bug Fixes

TypeDoc now properly flags readonly index signatures.
TypeDoc will now use the first signature's comment for later signatures in
overloads if present, #2718.
Fixed handling of @enum if the type was declared before the variable, #2719.
Fixed empty top level modules page in packages mode, #2753.
TypeDoc can now link to type alias properties, #2524.
TypeDoc will now document the merged symbol type when considering globals
declared inside declare global, #2774
TypeDoc now converts declare module "foo" as a module rather than a namespace, #2778.
Import types in type aliases now use module member references if present, #2779.
Fixed an issue where properties were not properly marked optional in some
cases. This primarily affected destructured parameters.
Added yaml to the highlight languages supported by default.
TypeDoc now recognizes txt as an alias of text to indicate a code block
should not be highlighted.
Items which are hidden with @ignore or @hidden but still referenced by
other types will no longer produce warnings about not being exported.
If a project only has one module within it, TypeDoc will now consider that
module when resolving @link tags.
The arrows to indicate whether or not a section is open now work when
JavaScript is disabled.
Group/category search boosts are now applied when writing the search index
rather than when converting. This prevents issues where boosts used by just
one package were incorrectly reported as unused when running with
entryPointStrategy set to packages.

Thanks!

`v0.26.11`

Compare Source

Features

If hostedBaseUrl is set to the root page on a website, TypeDoc will now include WebSite structured data, #2760.

Bug Fixes

Fix support for ESM config files with Node 23, #2752.
Fix type errors when using "module": "ESNext" and importing TypeDoc, #2747.
Inherited comments on overloaded methods now consider the overload position when inheriting a comment, #2755.

`v0.26.10`

Compare Source

Bug Fixes

Fixed missing space on page headers, #2748.

`v0.26.9`

Compare Source

Features

Added headings option to control optional headings, #2729.
Updated Chinese translations, #2739.
Added a folder icon to page navigation elements which are not links, #2741.

Bug Fixes

externalSymbolLinkMappings now uses the TypeScript reported link target if available, #2725.
TypeDoc will no longer omit the modules page if a project contains only modules/documents, #2730.
Fixed missing breadcrumbs on project page, #2728.
TypeDoc will no longer render an empty readme page if no readme was found.

Thanks!

`v0.26.8`

Compare Source

Features

Updated Chinese translations, #2706.
Exported constants no longer render the type and default value if they are the same, #2717.
The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #2723.

Bug Fixes

Correctly handle external link resolver link text when referencing an external symbol, #2700.
Big integer literals are now supported as default values, #2721.
Corrected handling of @link tags present in comments at the start of source files.
The index will now display when a module only contains documents, #2722.
ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol.
This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.

Thanks!

`v0.26.7`

Compare Source

Features

Support TypeScript 5.6, #2699.
Added customJs option to include a script tag in generated HTML output, #2650.
Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #2679.
Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #2685.
Added support for the @abstract tag, #2692.

Bug Fixes

Fixed an issue where links in packages mode would be resolved incorrectly, #2680.
@link tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.
Fixed handling of @param tags on comments attached to function callback parameters, #2683.
The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #2684.
Fixed incorrect placement of parameter default values in some signatures with a this parameter, #2698.

Thanks!

`v0.26.6`

Compare Source

Features

Use of the @extends block tag no longer produces warnings, #2659.
This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.

Bug Fixes

The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
Restored re-exports in the page navigation menu, #2671.
JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod#6.
In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

`v0.26.5`

Compare Source

Features

TypeDoc now exposes array option defaults under OptionDefaults, #2640.

Bug Fixes

Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.
Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.
TypeDoc no longer crashes when @document includes an empty file, #2638.
API: Event listeners added later with the same priority will be called later, #2643.

Thanks!

@bladerunner2020

`v0.26.4`

Compare Source

Bug Fixes

The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #2625.
Page navigation now ensures the current page is visible when the page is first loaded, #2626.
If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627.
@link tags will now be validated in referenced markdown documents, #2629.
@link tags are now resolved in project documents, #2629.
HTML/JSON output generated by TypeDoc now contains a trailing newline, #2632.
TypeDoc now correctly handles markdown documents with CRLF line endings, #2628.
@hidden is now properly applied when placed in a function implementation comment, #2634.
Comments on re-exports are now rendered.

Thanks!

`v0.26.3`

Compare Source

Features

"On This Page" navigation now includes the page groups in collapsible sections, #2616.

Bug Fixes

mailto: links are no longer incorrectly recognized as relative paths, #2613.
Added @since to the default list of recognized tags, #2614.
Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.

`v0.26.2`

Compare Source

Features

Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from
parsing comments in declaration files, #2611.
Improved comment discovery to more closely match TypeScript's discovery when getting comments
for members of interfaces/classes, #2084, #2545.

Bug Fixes

The text non-highlighted language no longer causes warnings when rendering, #2610.
If a comment on a method is inherited from a parent class, and the child class does not
use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

`v0.26.1`

Compare Source

Features

If hostedBaseUrl is set to the root page on a website, TypeDoc will now include WebSite structured data, #2760.

Bug Fixes

Fix support for ESM config files with Node 23, #2752.
Fix type errors when using "module": "ESNext" and importing TypeDoc, #2747.
Inherited comments on overloaded methods now consider the overload position when inheriting a comment, #2755.

`v0.26.0`

Compare Source

Breaking Changes

Drop support for Node 16.
Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions needs to be updated to use markdownItOptions.
Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
Changed default of --excludePrivate to true.
Renamed --sitemapBaseUrl to --hostedBaseUrl to reflect that it can be used for more than just the sitemap.
Removed deprecated navigation.fullTree option.
Removed --media option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.
Removed --includes option, use the @document tag instead.
Removed --stripYamlFrontmatter option, TypeDoc will always do this now.
Renamed the --htmlLang option to --lang.
Removed the --gaId option for Google Analytics integration and corresponding analytics theme member, #2600.
All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments
were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where Converter.EVENT_CREATE_DECLARATION
was emitted for ProjectReflection in some circumstances.
API: MapOptionDeclaration.mapError has been removed.
API: Deprecated BindOption decorator has been removed.
API: DeclarationReflection.indexSignature has been renamed to DeclarationReflection.indexSignatures.
Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
API: JSONOutput.SignatureReflection.typeParameter has been renamed to typeParameters to match the JS API.
API: DefaultThemeRenderContext.iconsCache has been removed as it is no longer needed.
API: DefaultThemeRenderContext.hook must now be passed context if required by the hook.

Features

Added support for TypeScript 5.5.
Added new --projectDocuments option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.
TypeDoc now has the architecture in place to support localization. No languages besides English
are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
Added support for a packageOptions object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages, #2523.
--hostedBaseUrl will now be used to generate a <link rel="canonical"> element in the project root page, #2550.
Added support for documenting individual elements of a union type, #2585.
Note: This feature is only available on type aliases directly containing unions.
TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.
New option, --customFooterHtml to add custom HTML to the generated page footer, #2559.
TypeDoc will now copy modifier tags to children if specified in the --cascadedModifierTags option, #2056.
TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both @alpha and @beta), #2056.
Groups and categories can now be collapsed in the page body, #2330.
Added support for JSDoc @hideconstructor tag.
This tag should only be used to work around TypeScript#58653, prefer the more general @hidden/@ignore tag to hide members normally, #2577.
Added --useHostedBaseUrlForAbsoluteLinks option to use the --hostedBaseUrl option to produce absolute links to pages on a site, #940.
Tag headers now generate permalinks in the default theme, #2308.
TypeDoc now attempts to use the "most likely name" for a symbol if the symbol is not present in the documentation, #2574.
Fixed an issue where the "On This Page" section would include markdown if the page contained headings which contained markdown.
TypeDoc will now warn if a block tag is used which is not defined by the --blockTags option.
Added three new sort strategies documents-first, documents-last, and alphabetical-ignoring-documents to order markdown documents.
Added new --alwaysCreateEntryPointModule option. When set, TypeDoc will always create a Module for entry points, even if only one is provided.
If --projectDocuments is used to add documents, this option defaults to true, otherwise, defaults to false.
Added new --highlightLanguages option to control what Shiki language packages are loaded.
TypeDoc will now render union elements on new lines if there are more than 3 items in the union.
TypeDoc will now only render the "Type Declaration" section if it will provide additional information not already presented in the page.
This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type.
Added comment.beforeTags and comment.afterTags hooks for plugin use.
Combined with CommentTag.skipRendering this can be used to provide custom tag handling at render time.

Bug Fixes

TypeDoc now supports objects with multiple index signatures, #2470.
Header anchor links in rendered markdown are now more consistent with headers generated by TypeDoc, #2546.
Types rendered in the Returns header are now properly colored, #2546.
Links added with the navigationLinks option are now moved into the pull out navigation on mobile displays, #2548.
@license and @import comments will be ignored at the top of files, #2552.
Fixed issue in documentation validation where constructor signatures where improperly considered not documented, #2553.
Keyboard focus is now visible on dropdowns and checkboxes in the default theme, #2556.
The color theme label in the default theme now has an accessible name, #2557.
Fixed issue where search results could not be navigated while Windows Narrator was on, #2563.
charset is now correctly cased in <meta> tag generated by the default theme, #2568.
Fixed very slow conversion on Windows where Msys git was used by typedoc to discover repository links, #2586.
Validation will now be run in watch mode, #2584.
Fixed an issue where custom themes which added dependencies in the <head> element could result in broken icons, #2589.
@default and @defaultValue blocks are now recognized as regular blocks if they include inline tags, #2601.
Navigation folders sharing a name will no longer be saved with a shared key to localStorage.
The --hideParameterTypesInTitle option no longer applies when rendering function types.
Broken @link tags in readme files will now cause a warning when link validation is enabled.
Fixed externalSymbolLinkMappings option's support for meanings in declaration references.
Buttons to copy code now have the type=button attribute set to avoid being treated as submit buttons.
--hostedBaseUrl will now implicitly add a trailing slash to the generated URL.

Thanks!

`v0.25.13`

Compare Source

Features

Added gitRevision:short placeholder option to --sourceLinkTemplate option, #2529.
Links generated by TypeDoc will now default to using the non-short git revision.
Moved "Generated by TypeDoc" footer into a <footer> tag, added footer.begin and footer.end
render hooks for use by custom plugins, #2532.

Bug Fixes

Fixed conversion of NoInfer missing type parameter reference, #2539.
Linking to a member on a page no longer incorrectly claims that
"This member is normally hidden due to your filter settings" for every member.

Thanks!

@xuhdev

`v0.25.12`

Compare Source

Features

Added support for TypeScript 5.4, #2517.

Bug Fixes

Updated page font to work around issues with Mac rendering, #2518.

Thanks!

@docmattman

`v0.25.11`

Compare Source

Bug Fixes

Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #2514.
"On This Page" section is now smarter when handling page headings which do not follow the normal h1>h2>h3 process, #2515.

`v0.25.10`

Compare Source

Bug Fixes

Constructed references to enum types will be properly linked with @interface, #2508.
Comments on property-methods will no longer be duplicated in generated documentation, #2509.
Reduced rendered docs size by writing icons to a referenced SVG asset, #2505.
For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.

`v0.25.9`

Compare Source

Features

Literal numeric unions will now be sorted during conversion, #2502.

Bug Fixes

Module readmes will now be included in JSON output, #2500.
Fixed crash when --excludeNotDocumented was used and the project contained a reference to a removed signature, #2496.
Fixed crash when converting an infinitely recursive type via a new --maxTypeConversionDepth option, #2507.
Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.

Thanks!

@JMBeresford

`v0.25.8`

Compare Source

Features

Added a new --sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
Added support for the @class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479.
Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
Added support for @groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
API: Exposed Context.getNodeComment for plugin use, #2498.

Bug Fixes

Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
A class which implements itself will no longer cause a crash when rendering HTML, #2495.
Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
API: Context.programs will no longer contain duplicates, #2498.

`v0.25.7`

Compare Source

Bug Fixes

Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #2476.
Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #2469.

`v0.25.6`

Compare Source

Bug Fixes

Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
Improved infinite loop detection in type converter to reduce false positives.

`v0.25.5`

Compare Source

`v0.25.4`

Compare Source

Features

Added support for TypeScript 5.3, #2446.
TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449.
This can be controlled through the new DefaultThemeRenderContext.reflectionPreview helper.
Improved type rendering to highlight keywords differentl

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

CLAassistant · 2022-08-17T00:08:43Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

renovate · 2024-11-27T11:56:13Z

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

any of the package files in this branch needs updating, or
the branch becomes conflicted, or
you click the rebase/retry checkbox if found above, or
you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json

npm warn Unknown env config "store". This will stop working in the next major version of npm.
npm error code ERESOLVE
npm error ERESOLVE unable to resolve dependency tree
npm error
npm error While resolving: [email protected]
npm error Found: [email protected]
npm error node_modules/typescript
npm error   dev typescript@"^4.9.4" from the root project
npm error
npm error Could not resolve dependency:
npm error peer typescript@"5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x" from [email protected]
npm error node_modules/typedoc
npm error   dev typedoc@"^0.28.0" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /runner/cache/others/npm/_logs/2025-06-19T16_07_55_641Z-eresolve-report.txt
npm error A complete log of this run can be found in: /runner/cache/others/npm/_logs/2025-06-19T16_07_55_641Z-debug-0.log

renovate · 2025-06-19T16:11:54Z

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update (^0.28.0). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the ignoreDeps array of your Renovate config.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

renovate bot force-pushed the renovate/typedoc-0.x branch from 398e0d4 to bed81e8 Compare August 26, 2022 05:51

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.10~~ chore(deps): update dependency typedoc to v0.23.11 Aug 26, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from bed81e8 to 5926f23 Compare August 31, 2022 05:39

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.11~~ chore(deps): update dependency typedoc to v0.23.12 Aug 31, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from 5926f23 to 9a8b17c Compare September 1, 2022 03:16

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.12~~ chore(deps): update dependency typedoc to v0.23.13 Sep 1, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from 9a8b17c to b310180 Compare September 3, 2022 13:55

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.13~~ chore(deps): update dependency typedoc to v0.23.14 Sep 3, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from b310180 to 652c08a Compare September 18, 2022 18:33

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.14~~ chore(deps): update dependency typedoc to v0.23.15 Sep 18, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from 652c08a to 1fc66a1 Compare October 10, 2022 23:09

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.15~~ chore(deps): update dependency typedoc to v0.23.16 Oct 10, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from 1fc66a1 to 9507a74 Compare October 25, 2022 16:51

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.16~~ chore(deps): update dependency typedoc to v0.23.18 Oct 25, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from 9507a74 to 8f258bf Compare October 26, 2022 13:56

renovate bot changed the title ~~chore(deps): update dependency typedoc to v0.23.18~~ chore(deps): update dependency typedoc to ^0.23.0 Oct 26, 2022

renovate bot changed the title ~~chore(deps): update dependency typedoc to ^0.23.0~~ Update dependency typedoc to ^0.23.0 Dec 17, 2022

renovate bot changed the title ~~Update dependency typedoc to ^0.23.0~~ chore(deps): update dependency typedoc to ^0.23.0 Dec 17, 2022

renovate bot force-pushed the renovate/typedoc-0.x branch from 8f258bf to 8b2d6b1 Compare January 13, 2023 19:38

renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from 9ad1ad4 to 8a1f728 Compare March 16, 2023 19:24

apaparazzi0329 force-pushed the master branch from b2ae9f5 to 8815b1a Compare March 16, 2023 20:57

renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from 3fe48ee to f60d51e Compare March 16, 2023 21:07

renovate bot force-pushed the renovate/typedoc-0.x branch from f60d51e to 66da074 Compare April 9, 2023 02:12

renovate bot changed the title ~~chore(deps): update dependency typedoc to ^0.23.0~~ chore(deps): update dependency typedoc to ^0.24.0 Apr 9, 2023

renovate bot force-pushed the renovate/typedoc-0.x branch from 66da074 to b0a56f7 Compare August 26, 2023 14:53

renovate bot changed the title ~~chore(deps): update dependency typedoc to ^0.24.0~~ chore(deps): update dependency typedoc to ^0.25.0 Aug 26, 2023

renovate bot force-pushed the renovate/typedoc-0.x branch from b0a56f7 to 20a5f18 Compare October 13, 2023 17:23

renovate bot force-pushed the renovate/typedoc-0.x branch 3 times, most recently from d9358be to d18d57a Compare February 26, 2024 20:13

renovate bot force-pushed the renovate/typedoc-0.x branch 3 times, most recently from ac5f86e to 45c1e1a Compare March 14, 2024 15:21

renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from e72cef4 to a7e0733 Compare May 17, 2024 17:21

renovate bot force-pushed the renovate/typedoc-0.x branch from a7e0733 to b52f8eb Compare June 22, 2024 20:28

renovate bot changed the title ~~chore(deps): update dependency typedoc to ^0.25.0~~ chore(deps): update dependency typedoc to ^0.26.0 Jun 22, 2024

renovate bot force-pushed the renovate/typedoc-0.x branch from b52f8eb to 764b31c Compare November 27, 2024 11:56

renovate bot changed the title ~~chore(deps): update dependency typedoc to ^0.26.0~~ chore(deps): update dependency typedoc to ^0.27.0 Nov 27, 2024

renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from dd61010 to 8bd1b40 Compare December 4, 2024 22:06

apaparazzi0329 force-pushed the master branch from e797470 to 998fee2 Compare December 4, 2024 22:15

renovate bot force-pushed the renovate/typedoc-0.x branch from 8bd1b40 to c9d0e86 Compare January 15, 2025 14:22

renovate bot force-pushed the renovate/typedoc-0.x branch from c9d0e86 to 9abbf64 Compare March 16, 2025 12:18

renovate bot changed the title ~~chore(deps): update dependency typedoc to ^0.27.0~~ chore(deps): update dependency typedoc to ^0.28.0 Mar 16, 2025

chore(deps): update dependency typedoc to ^0.28.0

91b5ab9

renovate bot force-pushed the renovate/typedoc-0.x branch from 9abbf64 to 91b5ab9 Compare June 19, 2025 16:08

apaparazzi0329 closed this Jun 19, 2025

renovate bot deleted the renovate/typedoc-0.x branch June 19, 2025 16:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(deps): update dependency typedoc to ^0.28.0 #1174

chore(deps): update dependency typedoc to ^0.28.0 #1174

Uh oh!

renovate bot commented Aug 17, 2022 •

edited

Loading

Uh oh!

CLAassistant commented Aug 17, 2022

Uh oh!

renovate bot commented Nov 27, 2024 •

edited

Loading

Uh oh!

renovate bot commented Jun 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

chore(deps): update dependency typedoc to ^0.28.0 #1174

chore(deps): update dependency typedoc to ^0.28.0 #1174

Uh oh!

Conversation

renovate bot commented Aug 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes

Breaking Changes

API Breaking Changes

Features

Bug Fixes

Thanks!

Features

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Bug Fixes

Thanks!

Features

Bug Fixes

Features

Bug Fixes

Thanks!

Bug Fixes

Bug Fixes

Breaking Changes

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Features

Bug Fixes

Thanks!

Bug Fixes

Thanks!

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Breaking Changes

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Thanks!

Bug Fixes

Bug Fixes

Features

Bug Fixes

Thanks!

Features

Bug Fixes

Bug Fixes

Bug Fixes

Features

Configuration

renovate bot commented Aug 17, 2022 •

edited

Loading

renovate bot commented Nov 27, 2024 •

edited

Loading